<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="UTF-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
	<title>如何使用脚本 | ElasticSearch 7.7 权威指南中文版</title>
	<meta name="keywords" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <meta name="description" content="ElasticSearch 权威指南中文版, elasticsearch 7, es7, 实时数据分析，实时数据检索" />
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
	<link rel="stylesheet" type="text/css" href="../static/styles.css" />
	<script>
	var _link = 'modules-scripting-using.html';
    </script>
</head>
<body>
<div class="main-container">
    <section id="content">
        <div class="content-wrapper">
            <section id="guide" lang="zh_cn">
                <div class="container">
                    <div class="row">
                        <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                            <div style="color:gray; word-break: break-all; font-size:12px;">原英文版地址: <a href="https://www.elastic.co/guide/en/elasticsearch/reference/7.7/modules-scripting-using.html" rel="nofollow" target="_blank">https://www.elastic.co/guide/en/elasticsearch/reference/7.7/modules-scripting-using.html</a>, 原文档版权归 www.elastic.co 所有<br/>本地英文版地址: <a href="../en/modules-scripting-using.html" rel="nofollow" target="_blank">../en/modules-scripting-using.html</a></div>
                        <!-- start body -->
                  <div class="page_header">
<strong>重要</strong>: 此版本不会发布额外的bug修复或文档更新。最新信息请参考 <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html" rel="nofollow">当前版本文档</a>。
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch 权威指南 [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="modules-scripting.html">脚本</a></span>
»
<span class="breadcrumb-node">如何使用脚本</span>
</div>
<div class="navheader">
<span class="prev">
<a href="modules-scripting.html">« 脚本</a>
</span>
<span class="next">
<a href="modules-scripting-fields.html">访问文档字段和特殊变量 »</a>
</span>
</div>
<div class="chapter">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="modules-scripting-using"></a>如何使用脚本
</h2>
</div></div></div>
<p>
只要是Elasticsearch API中支持脚本的地方，语法都遵循相同的模式：
</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">  "script": {
    "lang":   "...",  <a id="CO280-1"></a><i class="conum" data-value="1"></i>
    "source" | "id": "...", <a id="CO280-2"></a><i class="conum" data-value="2"></i>
    "params": { ... } <a id="CO280-3"></a><i class="conum" data-value="3"></i>
  }</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO280-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>编写脚本的语言，默认为<code class="literal">painless</code>。</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO280-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>可以被指定为内联脚本的<code class="literal">source</code>或存储脚本的<code class="literal">id</code>的脚本本身。</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO280-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>应该传递到脚本中的任何命名参数。</p>
</td>
</tr>
</table>
</div>
<p>
例如，下面的脚本在搜索请求中用于返回<a class="xref" href="search-request-body.html#request-body-search-script-fields" title="Script Fields">脚本字段(scripted field)</a>：
</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">PUT my_index/_doc/1
{
  "my_field": 5
}

GET my_index/_search
{
  "script_fields": {
    "my_doubled_field": {
      "script": {
        "lang":   "expression",
        "source": "doc['my_field'] * multiplier",
        "params": {
          "multiplier": 2
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/592.console"></div>
<h3>
<a id="_script_parameters"></a>脚本参数
</h3>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">lang</code>
</span>
</dt>
<dd>
指定编写脚本的语言。默认为<code class="literal">painless</code>。
</dd>
<dt>
<span class="term">
<code class="literal">source</code>, <code class="literal">id</code>
</span>
</dt>
<dd>
指定脚本的源(source)。

如上例所示，<code class="literal">内联(inline)</code>脚本被指定为源(<code class="literal">source</code>)。

存储的(<code class="literal">stored</code>)脚本是指定<code class="literal">id</code>，并从集群状态中检索(请参见<a class="xref" href="modules-scripting-using.html#modules-scripting-stored-scripts" title="存储的脚本">存储的脚本</a>)。
</dd>
<dt>
<span class="term">
<code class="literal">params</code>
</span>
</dt>
<dd>
指定作为变量传递到脚本中的任何命名参数。
</dd>
</dl>
</div>
<div class="important admon">
<div class="icon"></div>
<div class="admon_content">
<h3>首选参数<a id="prefer-params"></a>
</h3>
<p>
Elasticsearch第一次看到一个新脚本时，它会编译它并将编译后的版本存储在缓存中。

编译可能是一个繁重的处理过程。
</p>
<p>
如果你需要将变量传递到脚本中，应该将它们作为命名的<code class="literal">params</code>传递，而不是将值硬编码到脚本本身中。

例如，如果你希望能够将字段值乘以不同的乘数，请不要将乘数硬编码到脚本中：
</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">  "source": "doc['my_field'] * 2"</pre>
</div>
<p>相反，将其作为命名参数传入：</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">  "source": "doc['my_field'] * multiplier",
  "params": {
    "multiplier": 2
  }</pre>
</div>
<p>
每当乘数改变时，第一个版本必须重新编译，而第二个版本只编译一次。
</p>
<p>
如果你在很短的时间内编译了太多不同的脚本，Elasticsearch将拒绝新的动态脚本，并抛出一个<code class="literal">circuit_breaking_exception</code>错误。

默认情况下，每分钟最多可以编译15个内联脚本。

可以通过设置<code class="literal">script.max_compilations_rate</code>来动态更改此设置。
</p>
</div>
</div>
<h3>
<a id="modules-scripting-short-script-form"></a>短脚本形式(short script form)
</h3>
<p>
为了简洁，可以使用简短的脚本形式。

短形式下，<code class="literal">script</code>由字符串而不是对象表示。

该字符串包含脚本的源(source)。
</p>
<p>脚本的简短形式：</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">  "script": "ctx._source.likes++"</pre>
</div>
<p>而相同脚本的一般形式是：</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">  "script": {
    "source": "ctx._source.likes++"
  }</pre>
</div>
<h3>
<a id="modules-scripting-stored-scripts"></a>存储的脚本
</h3>
<p>
可以使用<code class="literal">_scripts</code>终端在集群状态中存储和检索脚本。
</p>
<p>
如果启用了Elasticsearch安全功能，你必须拥有以下权限才能创建、检索和删除存储的脚本：
</p>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
cluster: <code class="literal">all</code> 或 <code class="literal">manage</code>
</li>
</ul>
</div>
<p>
有关更多信息，请参见<a class="xref" href="security-privileges.html" title="安全权限" rel="nofollow">安全权限</a>。
</p>
<h4>
<a id="_request_examples"></a>请求示例
</h4>
<p>
下面是一个使用位于<code class="literal">/_scripts/{id}</code>的存储脚本的示例。
</p>
<p>
首先，在集群状态中创建名为<code class="literal">calculate-score</code>的脚本：
</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _scripts/calculate-score
{
  "script": {
    "lang": "painless",
    "source": "Math.log(_score * 2) + params.my_modifier"
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/593.console"></div>
<p>
你还可以指定一个上下文作为url路径的一部分，以<code class="literal">/_scripts/{id}/{context}</code>的形式根据该特定上下文编译存储的脚本：
</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">POST _scripts/calculate-score/score
{
  "script": {
    "lang": "painless",
    "source": "Math.log(_score * 2) + params.my_modifier"
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/594.console"></div>
<p>
同样的脚本可以通过以下方式检索：
</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET _scripts/calculate-score</pre>
</div>
<div class="console_widget" data-snippet="snippets/595.console"></div>
<p>
可以通过指定参数<code class="literal">id</code>来使用存储的脚本，如下所示：
</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET twitter/_search
{
  "query": {
    "script_score": {
      "query": {
        "match": {
            "message": "some message"
        }
      },
      "script": {
        "id": "calculate-score",
        "params": {
          "my_modifier": 2
        }
      }
    }
  }
}</pre>
</div>
<div class="console_widget" data-snippet="snippets/596.console"></div>
<p>删除脚本：</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">DELETE _scripts/calculate-score</pre>
</div>
<div class="console_widget" data-snippet="snippets/597.console"></div>
<h3>
<a id="modules-scripting-search-templates"></a>搜索模板(search templates)
</h3>
<p>
还可以使用<code class="literal">_scripts</code> API来存储<span class="strong strong"><strong>搜索模板(search templates)</strong></span>。

搜索模板保存带有占位符值(称为模板参数)的特定<a class="xref" href="search-search.html" title="搜索 API" rel="nofollow">搜索请求</a>。
</p>
<p>
你可以使用存储的搜索模板来运行搜索，而无需写出整个查询。

只需提供存储模板的ID和模板参数。

当你希望快速无误地运行常用查询时，这很有用。
</p>
<p>
搜索模板使用<a href="http://mustache.github.io/mustache.5.html" class="ulink" target="_top">mustache模板语言</a>。

更多详情和示例请参见<a class="xref" href="search-template.html" title="Search Template">搜索模板</a>。
</p>
<h3>
<a id="modules-scripting-using-caching"></a>脚本缓存
</h3>
<p>
默认情况下，所有脚本都会被缓存，它们只需要在变更时重新编译。

默认情况下，脚本没有过期时间，但是你可以通过使用<code class="literal">script.cache.expire</code>设置来更改此行为。

可以使用<code class="literal">script.cache.max_size</code>设置来配置此缓存的个数。

默认情况下，缓存的脚本的个数为<code class="literal">100</code>。
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>
脚本的大小限制为65,535字节。

这可以通过设置<code class="literal">script.max_size_in_bytes</code>设置来增加该软限制，但如果脚本非常大，则应考虑使用<a class="xref" href="modules-scripting-engine.html" title="高级脚本使用脚本引擎" rel="nofollow">原生脚本引擎(native script engine)</a>。
</p>
</div>
</div>
<h3>
<a id="modules-scripting-errors"></a>脚本错误
</h3>
<p>
当存在编译或运行时异常时，Elasticsearch会返回错误的详细信息。

此响应的内容有助于跟踪问题。
</p>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>
此功能是试验性的，在未来的版本中可能会被更改或完全删除。

Elastic将尽最大努力解决任何问题，但实验功能不受官方GA功能的支持SLA的约束。
</p>
</div>
</div>
<p>
<code class="literal">position</code>的内容是实验性的，可能会发生变化。
</p>
</div>
<div class="navfooter">
<span class="prev">
<a href="modules-scripting.html">« 脚本</a>
</span>
<span class="next">
<a href="modules-scripting-fields.html">访问文档字段和特殊变量 »</a>
</span>
</div>
</div>

                  <!-- end body -->
                        </div>
                        <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                        
                        </div>
                    </div>
                </div>
            </section>
        </div>
    </section>
</div>
<script src="../static/cn.js"></script>
</body>
</html>